/*
XPTracker - Alternative Agile Tracking Tool
Copyright (C) 2006-2009  Stephen Starkey

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
*/
package org.xptracker.domain;

import java.lang.annotation.*;

/**
 * Marks methods which should be indexed for searching.
 * @author caliendo
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SearchField {

  /** 
   * The query field to index with.
   * @return 
   *    the query field
   */
  public String queryField();

  public String description();

  public String example() default "";

  public String format() default "";

  /**
   * If true, the value should be stored in the index.
   * By default, this value is false.
   * @return 
   *    whether the value should be stored
   */
  public boolean stored() default false;

}
